BlueCielo Publisher 2012 Administrator's Guide | BlueCielo ECM Solutions

You are here: VBScript reference > About the objects > About the MeridianQueue object > The MeridianQueue object methods > BeginBatch method
NEW  BeginBatch method

Begins collection of a batch of documents to register in the Publisher queue.

Syntax

Function BeginBatch (vaultId)
Parameters
Name Description

vaultId

A string that uniquely identifies the vault in which the document resides. Specify Nothing or an empty string to work in the same vault where the VBScript runs. The vault identifier has the syntax \\server\vault, where server is the name of the server computer and vault is the internal name of the vault or datastore. The vault identifier may consist of only a vault name, in which case the vault’s default server, if set, will be assumed.

Remarks

This method must be called in the _Initialize event procedure of a custom command, similar to the following example. If this is not done, then the RegisterDocument method registers documents in the queue individually.

If any document is registered more than once, the options described in Configuring a Meridian Enterprise application server will determine the disposition of the batch.

Example

Sub TestPublisher_Execute(Batch)
  On Error Resume Next
  'Create the script object.
  Set Publisher = New PublisherScriptObject  
  'Register the selected document for publishing.
  Call Publisher.Queue.RegisterDocument("", "1B4423", Document.ID, , , , , ,"")
  'Release the script object.
  Set Publisher = Nothing   
  If Err.Number <> 0 Then  
   WinMsgBox "Publish failed: " +  Err.Description
      Err.Clear 
  End If
End Sub


Sub TestPublisher_Initialize(Batch)
  'Create the script object.
  Set Publisher = New PublisherScriptObject  
  'Initialize batch operation.
  Call Publisher.Queue.BeginBatch
  'Release the script object.
  Set Publisher = Nothing 
End Sub

Sub TestPublisher_Terminate(Batch)
  On Error Resume Next
  'Create the script object.
  Set Publisher = New PublisherScriptObject  
  'Initialize batch operation.
  Call Publisher.Queue.CommitBatch
  'Release the script object.
  Set Publisher = Nothing 
  If Err.Number <> 0 Then  
   WinMsgBox "Publish failed: " +  Err.Description
      Err.Clear       
  End If  
End Sub

Related concepts

VBScript reference

Disabling assembly signature verification

Related information

NEW CommitBatch method

DocumentID property

FeedbackProperty property

JobCode property

PreventDuplicate property

PublishOptions property

RegisterDocument method

RenderOptions property

RevisionID property

NEW RevokeBatch method

UserName property


Copyright © 2000-2012 BlueCielo ECM Solutions

www.bluecieloecm.com